package com.cmc.cloud.cmclink.doc.api.document;

import com.cmc.cloud.cmclink.doc.api.document.rep.BkgTarriffNoRespDto;
import com.cmc.cloud.cmclink.doc.constant.DocApiConstants;
import com.cmes.framework.common.pojo.CommonResult;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
/**
 * @author 陈正
 * @decr 订舱公布价约号数据对外查询 api
 * @date 2025/7/8
 */
@FeignClient(name = DocApiConstants.NAME)
@Tag(name = "RPC 服务 - 订舱公布价约号对外接口服务")
public interface BkgTarriffNoQueryApi {

    String PREFIX = DocApiConstants.PREFIX + "/tarriffNo";

    /**
     * 根据基础数据编码类型等查询基础数据
     *
     * @param bkpCode 订舱人代码
     * @return 获得订舱公布价约号
     */
    @Operation(summary = "通过订舱人代码 获得订舱公布价约号")
    @Parameter(name = "bkpCode", description = "订舱人代码", required = true, example = "CSM1938138026941980672")
    @GetMapping(PREFIX + "/getByBkpCode/{bkpCode}")
    CommonResult<BkgTarriffNoRespDto> getByBkpCode(@PathVariable("bkpCode") String bkpCode);
}
